/*
 * Copyright 2008 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.gwt.widgetideas.client.event;

/**
 * Highlight event.
 * 
 * @param <HighlightType> type to be highlighted
 */
public class HighlightEvent<HighlightType> extends
    AbstractEvent<FiresHighlightEvents, HighlightHandler<HighlightType>> {
  private HighlightType highlighted;

  /**
   * Constructor.
   * 
   * @param source event source
   * @param highlighted highlighted value
   */
  public HighlightEvent(FiresHighlightEvents source, HighlightType highlighted) {
    super(source);
    this.highlighted = highlighted;
  }

  @Override
  public void fire(HighlightHandler<HighlightType> e) {
    e.onHighlight(this);
  }

  /**
   * Gets the highlighted value.
   * 
   * @return the value
   */
  public HighlightType getHighlightedValue() {
    return highlighted;
  }
}
